ParcelTrack API
Getting Started
Step 1: Review API Documentation
To get started, go to the Developer Portal and review the information.
Step 2: Register for a NZ Post Online Account
If you don't already have one you will need to register a NZ Post Online Account. You will be prompted to enter some user information, an email address and a password. Note that the email address you provide in the registration process will by your username when logging into the Developer Portal.
Step 3: Request API Access for An Application
The first step is to register your applications with the API. At the top of the page click the “Request API access” button.
Either:
- Select one of your existing applications (if you have already requested access for other APIs)or
- Add a “new application”.
When registering a new Application include OAuth 2.0 grant type “Client Credentials Grant” to use this API.
Select the SLA tier you would like to use.
Read the Terms & Conditions and check the box to accept these.
Your access request will be assessed and once approved, you will receive an email containing a link to a page in the Developer Portal that will provide a client ID and client secret that you can use to access the API. If you require International Labeling solutions from this API, please ?specify this requirement to API@NZPost.co.nz. This product needs us to perform a different technical setup behind the scenes to get International labeling working for you. Please ensure you have the International Products of your choice also set up with your account manager.
Please note that you must request access to each API individually.